Skip to main content

更改认证字段键

更改场景

您想要更改一个或多个认证输入字段的键,这些字段是用户在将您的应用认证到 Zapier 时所需的。

对用户的影响

这是一种破坏性变更

修改现有认证字段的键会构成破坏性变更。如果未采取适当预防措施,由于迁移无法进行,现有的应用连接可能会中断。用户需要为您的集成建立新的连接,并手动刷新他们的每个 Zap。

最佳实践

我们强烈建议您尽量避免更改认证字段键

替代方案

如果您的 API 端点需要不同的属性用于认证,请考虑调整属性键,而不是修改表单字段输入的键。此修改需要在每个触发器、操作、搜索请求以及认证中进行。

注意:表单字段输入键无需直接匹配您的 API 预期的属性。

例如,假设您有一个表单字段输入,其键为 API-KEY,并使用相同的属性名称 API-KEY 将字段的值发送到您的 API。

Platform UI vs CLI comparison

headers: {
"API-KEY": bundle.authData.api_key; // 原始
}

接下来,您的 API 进行了更改,并期望请求属性为 X-API-KEY。您可以根据需要更改请求属性键(左侧),但仍可引用原始的表单字段输入(右侧)。

Platform UI vs CLI comparison

headers: {
"X-API-KEY": bundle.authData.api_key; // 新版 - 请求键和字段键可以不同
}